home *** CD-ROM | disk | FTP | other *** search
/ Sprite 1984 - 1993 / Sprite 1984 - 1993.iso / src / cmds / dump / RCS / dump.man,v < prev    next >
Text File  |  1991-11-22  |  7KB  |  220 lines
  1. head     1.4;
  2. branch   ;
  3. access   ;
  4. symbols  ;
  5. locks    ; strict;
  6. comment  @@;
  7.  
  8.  
  9. 1.4
  10. date     91.11.22.14.09.23;  author jhh;  state Exp;
  11. branches ;
  12. next     1.3;
  13.  
  14. 1.3
  15. date     91.09.10.11.19.09;  author jhh;  state Exp;
  16. branches ;
  17. next     1.2;
  18.  
  19. 1.2
  20. date     91.06.28.12.28.00;  author shirriff;  state Exp;
  21. branches ;
  22. next     1.1;
  23.  
  24. 1.1
  25. date     91.06.05.15.06.37;  author shirriff;  state Exp;
  26. branches ;
  27. next     ;
  28.  
  29.  
  30. desc
  31. @@
  32.  
  33.  
  34. 1.4
  35. log
  36. @added -u option
  37. @
  38. text
  39. @' $Header: /sprite/src/admin/dump.new/RCS/dump.man,v 1.3 91/09/10 11:19:09 jhh Exp $ SPRITE (Berkeley)
  40. .so \*(]ltmac.sprite
  41. .HS DUMP cmds
  42. .BS
  43. .SH NAME
  44. dump \- A program that dumps directories
  45. .SH SYNOPSIS
  46. \fBdump\fR [\fIoptions\fR] \fIdirectory\fR
  47. .SH OPTIONS
  48. .IP "\fB\-a \fR" 15
  49. Reset access times after dumping each file.
  50. .IP "\fB\-f  \fIfilename\fR" 15
  51. Use \fIfilename\fR as the name of the dump archive.
  52. .IP "\fB\-help \fR" 15
  53. Print a help message.
  54. .IP "\fB\-i number \fR" 15
  55. Initialize the tape, using \fBnumber\fR for the label.
  56. .IP "\fB\-l  \fIdigit\fR" 15
  57. The single digit in the range 0-9 specifies the dump level.  The default
  58. is zero.
  59. .IP "\fB\-m \fIusername\fR" 15
  60. Send mail to \fIusername\fR to report a fatal error, or successful completion.
  61. .IP "\fB\-r\fR" 15
  62. Re-initialize the tape.  Any data on the tape is lost.
  63. .IP "\fB\-s\fR" 15
  64. Safe re-initialization of tape.  The reinitialization will fail if the
  65. tape has been recently used.
  66. .IP "\fB\-t \fR" 15
  67. Print the dump archive table of contents.
  68. .IP "\fB\-v \fR" 15
  69. Verbose.  The name of each file is listed as it is dumped.
  70. .IP "\fB\-u \fR" 15
  71. Unofficial dump.  The dump is not recorded in the dumpdates file.
  72. .BE
  73.  
  74. .SH INTRODUCTION
  75. .PP
  76. The \fBdump\fR command is used to do an incremental dump of a
  77. set of directory.  It will recursively dump all files and
  78. subdirectories.  Each file that has been created or modified
  79. since the last lower level dump will
  80. be copied to the archive file.  For example, the command
  81. .DS
  82. dump -l 2 -f /dev/tape0 /sprite
  83.  
  84. .DE
  85. will dump all files in the directory \fB/sprite\fR
  86. in tar format, to \fB/dev/tape0\fR.
  87. .SH TAPE FORMAT
  88. .PP
  89. Dump tapes have a particular format. It is assumed that blocks on the
  90. tape cannot be overwritten, so the tape is written in an append-only fashion.
  91. When a tape is initialized a file called the tape \fIlabel\fP is written
  92. at the beginning of the tape.  
  93. Each time a filesystem is dumped a new updated tape label is written to
  94. the end of the tape, so that the current tape label is always the last
  95. one on the tape.  
  96. The tape label is 16 Kbytes in size, and
  97. consists of a sequence of ASCII strings separated by newlines.  The 
  98. first string is of the form
  99. .DS
  100. SPRITE DUMP TAPE, Version \fIv\fP Level \fIx\fP Tape \fIn\fP
  101.  
  102. .DE
  103. where \fIv\fP is the version of \fBdump\fP that wrote the tape,
  104. \fBx\fP is the level of the dump tape, and \fBn\fP is the dump tape number.
  105. The version is intended to allow future versions of \fBdump\fP to be 
  106. backwards compatible.
  107. The level is filled in when the tape is initialized, but is otherwise
  108. unused.  It could be used by \fBdump\fP and higher-level software to 
  109. automate the dumping process.
  110. .PP
  111. Subsequent lines in the tape label contain a table of contents for the tape,
  112. and are of the form
  113. .DS
  114. \fITapeNum FileNum MBDumped MBLeft Date FileSystem\fP
  115.  
  116. .DE
  117. where \fITapeNum\fP is the tape number, \fIFileNum\fP is the file number
  118. on tape corresponding to the current entry (starting with 1), 
  119. \fIMBDumped\fP is the number of MBytes dumped from the filesystem,
  120. \fIMBLeft\fP is the number of MBytes remaining on the tape after
  121. the filesystem was dumped, \fIDate\fP is the date when the filesystem was
  122. dumped, and \fIFileSystem\fP
  123. is the name of the filesystem that was dumped.
  124. .SH FILES
  125. .TP
  126. \fB/sprite/admin/dump/dumpdates\fP
  127. When a dump completes the information that is written into the tape label
  128. is also written into this file.
  129. Each line is of the form
  130. .sp
  131. \fITapeNum FileNum MBDumped MBLeft Date FileSystem\fP
  132. .sp
  133. .SP
  134. where \fITapeNum\fP is the tape number, \fIFileNum\fP is the file number
  135. on tape corresponding to the current entry (starting with 1), 
  136. \fIMBDumped\fP is the number of MBytes dumped from the filesystem,
  137. \fIMBLeft\fP is the number of MBytes remaining on the tape after
  138. the filesystem was dumped, \fIDate\fP is the date when the filesystem was
  139. dumped, and \fIFileSystem\fP
  140. is the name of the filesystem that was dumped.
  141. .TP
  142. \fB/sprite/admin/dump/dumplog\fP
  143. This file contains low-level debugging information that is printed out by
  144. \fBdump\fP as it runs.
  145. .TP
  146. \fB/sprite/admin/dump/statuslog\fP
  147. This file contains information about the status of both the tape drives
  148. and the tapes.
  149. A line is added to the file each time a dump completes, and is of the form
  150. .sp
  151. \fIDriveType Serial TapeNum MBDumped ErrorRate Date Device\fP
  152. .sp
  153. .SP
  154. \fIDriveType\fP is the type of drive that was used (e.g. EXB-8500).
  155. \fISerial\fP is the serial number of the drive.  
  156. The combination of the drive type
  157. and serial number should allow tape drives to be uniquely identified.
  158. \fITapeNumber\fP is the number of the tape that was used.
  159. \fIMBDumped\fP is the number of MBytes that were dumped. 
  160. \fIErrorRate\fP is the number of errors per tape access, expressed as
  161. a percentage of tape accesses.
  162. An error rate of 100% means that there was an average of one error per
  163. tape access.
  164. The definition of an error is vendor specific
  165. but an increase in the error rate over time may indicate that a tape is
  166. wearing out or that a drive needs servicing.
  167. The \fIDate\fP is the date on which the dump occurred,
  168. and the \fIDevice\fP is the name of the device as passed to the
  169. \fBdump\fP command.
  170. The latter should not be considered to uniquely identify a tape drive
  171. since the mapping between the device name and the device can change,
  172. thus the drive type and serial number should be used to look for 
  173. an increasing error rate on a particular drive.
  174. .SH KEYWORDS
  175. dump, restore, tape, backup, tar
  176.  
  177. @
  178.  
  179.  
  180. 1.3
  181. log
  182. @added new dump format and explained dump tape format
  183. @
  184. text
  185. @d1 1
  186. a1 1
  187. ' $Header: /sprite/src/admin/dump/RCS/dump.man,v 1.2 91/06/28 12:28:00 shirriff Exp Locker: jhh $ SPRITE (Berkeley)
  188. d32 2
  189. @
  190.  
  191.  
  192. 1.2
  193. log
  194. @Added safe reinitialization feature.
  195. @
  196. text
  197. @d1 1
  198. a1 1
  199. ' $Header: /sprite/src/admin/dump/RCS/dump.man,v 1.1 91/06/05 15:06:37 shirriff Exp Locker: shirriff $ SPRITE (Berkeley)
  200. a35 1
  201.  
  202. d42 1
  203. a42 1
  204. \fBdump -l 2 -f /dev/tape0 /sprite
  205. d47 28
  206. d76 58
  207. @
  208.  
  209.  
  210. 1.1
  211. log
  212. @Initial revision
  213. @
  214. text
  215. @d1 1
  216. a1 1
  217. ' $Header: /sprite/src/admin/dump/RCS/dump.man,v 1.2 89/06/16 13:21:06 rab Exp $ SPRITE (Berkeley)
  218. d25 3
  219. @
  220.